add data validation step #95

Degoot-AM · 2024-07-09T15:42:57Z

This PR adds data validation steps using the linelist package, addressing issue #94

github-actions · 2024-07-09T15:43:10Z

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

🎯 correct output
🖼️ correct figures
❓ new warnings
‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/epiverse-trace/tutorials-early/compare/md-outputs..md-outputs-PR-95

The following changes were observed in the rendered markdown documents:

 clean-data.md      |  280 +++++-
 config.yaml (gone) |   83 --
 describe-cases.md  |   10 +-
 md5sum.txt         |   26 +-
 read-cases.md      |   12 +-
 renv.lock (gone)   | 2706 ----------------------------------------------------
 setup.md           |   44 +-
 7 files changed, 318 insertions(+), 2843 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-09-13 09:08:31 +0000

avallecam

Thanks for the contribution @Degoot-AM!

This complementary content is appropriate to show the whole workflow of {linelist}: tag, validate, safeguard, and get a tagged-only data frame.

I think we can still work on the arrangement of this content to easily identify these four tasks.

For my edit suggestions, I suggest first incorporating the specific in-line edits (here on GitHub) and then working on the major content rearrangements (locally on our machines by new commits):

move the tags_df to the end
add a challenge to test a different saveguard
hide the tags_types output in a challenge hint to make this useful and not only descriptive
simplify the showing of the validate functions

Interested to discuss further any of these proposals.

episodes/clean-data.Rmd

avallecam · 2024-07-30T13:58:35Z

I think the main theme in this episode could be that "we need clean data to allow appropriate tagging and validation before running the analysis"

avallecam

Thanks @Degoot-AM for this modifications. This looks good!

I tested it as a learner. From this, I suggested using the simplest pieces of code to learn about the {linelist} outputs. Also suggested some text edits to make the content more readable. Lastly, I provided my longest edits to the challenges given that we can provide "formative assessments" based on code that could produce these moments of "oh! this has changed!" and then the learning, as is the approach you are following.

Note: some code solutions are in bullets on purpose to allow its writing. If accepted, will be removed as in #106

This is my last request for changes, I promise :D

episodes/clean-data.Rmd

Degoot-AM

Accepting changes proposed by @avallecam.

avallecam

Thanks for accepting the feedback edits. I added some extra commits to clarify some lines I suggested. Now ready to merge 🚀

Co-authored-by: Andree Valle Campos <[email protected]>

Degoot-AM assigned avallecam Jul 9, 2024

Degoot-AM added the post-trails label Jul 9, 2024

github-actions bot pushed a commit that referenced this pull request Jul 9, 2024

differences for PR #95

4032abb

avallecam mentioned this pull request Jul 29, 2024

replace the object name data with linelist_data #99

Closed

avallecam requested changes Jul 29, 2024

View reviewed changes

avallecam reviewed Jul 30, 2024

View reviewed changes

episodes/clean-data.Rmd Show resolved Hide resolved

avallecam reviewed Jul 30, 2024

View reviewed changes

episodes/clean-data.Rmd Outdated Show resolved Hide resolved

github-actions bot pushed a commit that referenced this pull request Aug 1, 2024

differences for PR #95

b71756b

github-actions bot pushed a commit that referenced this pull request Aug 1, 2024

differences for PR #95

fef4f2f

github-actions bot pushed a commit that referenced this pull request Aug 1, 2024

differences for PR #95

379e2d2

github-actions bot pushed a commit that referenced this pull request Aug 1, 2024

differences for PR #95

d731026

github-actions bot pushed a commit that referenced this pull request Aug 1, 2024

differences for PR #95

f8d2d07

github-actions bot pushed a commit that referenced this pull request Aug 1, 2024

differences for PR #95

ca21d92

github-actions bot pushed a commit that referenced this pull request Aug 1, 2024

differences for PR #95

6fff71b

github-actions bot pushed a commit that referenced this pull request Aug 1, 2024

differences for PR #95

bed8321

Degoot-AM requested a review from avallecam August 2, 2024 10:25

avallecam mentioned this pull request Sep 4, 2024

remove arguments from standardize_column_names() #105

Merged

avallecam linked an issue Sep 5, 2024 that may be closed by this pull request

Data validation #94

Closed

avallecam mentioned this pull request Sep 5, 2024

remove two tagging to include this in a formative assessment #106

Merged

avallecam requested changes Sep 5, 2024

View reviewed changes

avallecam mentioned this pull request Sep 6, 2024

remove bullet + inline code added on purpose during code review #109

Closed

avallecam added the clean-validation set of issues about the clean-validation episode label Sep 6, 2024

github-actions bot pushed a commit that referenced this pull request Sep 10, 2024

differences for PR #95

4a6593b

github-actions bot pushed a commit that referenced this pull request Sep 10, 2024

differences for PR #95

433f6d4

Degoot-AM commented Sep 10, 2024

View reviewed changes

github-actions bot pushed a commit that referenced this pull request Sep 10, 2024

differences for PR #95

b438d13

Degoot-AM requested a review from avallecam September 10, 2024 17:54

avallecam approved these changes Sep 12, 2024

View reviewed changes

Degoot-AM and others added 24 commits September 13, 2024 09:46

Update episodes/clean-data.Rmd

c13cdbf

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

196a611

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

b37101d

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

5d773b6

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

c4515c7

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

d56cbff

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

94e2a4e

Co-authored-by: Andree Valle Campos <[email protected]>

add new changes from PR#95

47d7d2d

add changes to address #75

7a79c53

Update episodes/clean-data.Rmd

32b3f8a

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

24155c0

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

911cd77

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

2356a56

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

095c484

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

08f1e75

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

3ae4180

Co-authored-by: Andree Valle Campos <[email protected]>

Update episodes/clean-data.Rmd

cd3ae76

Co-authored-by: Andree Valle Campos <[email protected]>

remove bullet + inline code (fix #109)

8370224

fix the length of output and text spelling.

a803b50

add one more line to the challenges intro

8ff2867

add tidyverse and suggest tag names function

48053e1

relocate challenge messages

ed23ba6

homogenize the use of pipe (fix #96)

7d6df35

fix lintr checks

13c0dba

avallecam force-pushed the data_validation branch from 7a380dd to 13c0dba Compare September 13, 2024 08:50

github-actions bot pushed a commit that referenced this pull request Sep 13, 2024

differences for PR #95

040c427

call tidyverse from start to import the pipe

994dea7

github-actions bot pushed a commit that referenced this pull request Sep 13, 2024

differences for PR #95

2e01f2a

avallecam merged commit 35ebc7d into main Sep 13, 2024
4 checks passed

avallecam deleted the data_validation branch September 13, 2024 09:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add data validation step #95

add data validation step #95

Degoot-AM commented Jul 9, 2024 •

edited by avallecam

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

avallecam left a comment •

edited

Loading

avallecam commented Jul 30, 2024

avallecam left a comment •

edited

Loading

Degoot-AM left a comment

avallecam left a comment

add data validation step #95

add data validation step #95

Conversation

Degoot-AM commented Jul 9, 2024 • edited by avallecam Loading

github-actions bot commented Jul 9, 2024 • edited Loading

Thank you!

Rendered Changes

avallecam left a comment • edited Loading

Choose a reason for hiding this comment

avallecam commented Jul 30, 2024

avallecam left a comment • edited Loading

Choose a reason for hiding this comment

Degoot-AM left a comment

Choose a reason for hiding this comment

avallecam left a comment

Choose a reason for hiding this comment

Degoot-AM commented Jul 9, 2024 •

edited by avallecam

Loading

github-actions bot commented Jul 9, 2024 •

edited

Loading

avallecam left a comment •

edited

Loading

avallecam left a comment •

edited

Loading